<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.freedesktop.UDisks2.Block: UDisks Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="UDisks Reference Manual">
<link rel="up" href="ch02.html" title="D-Bus Interfaces">
<link rel="prev" href="gdbus-org.freedesktop.UDisks2.MDRaid.html" title="org.freedesktop.UDisks2.MDRaid">
<link rel="next" href="gdbus-org.freedesktop.UDisks2.Partition.html" title="org.freedesktop.UDisks2.Partition">
<meta name="generator" content="GTK-Doc V1.29 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#gdbus-org.freedesktop.UDisks2.Block.description" class="shortcut">Description</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#gdbus-org.freedesktop.UDisks2.Block.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gdbus-org.freedesktop.UDisks2.MDRaid.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gdbus-org.freedesktop.UDisks2.Partition.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gdbus-org.freedesktop.UDisks2.Block"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gdbus-interface-org-freedesktop-UDisks2-Block.top_of_page"></a>org.freedesktop.UDisks2.Block</span></h2>
<p>org.freedesktop.UDisks2.Block — Block device</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Methods</h2>
<pre class="synopsis">
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.AddConfigurationItem" title="The AddConfigurationItem() method">AddConfigurationItem</a>    (IN  (sa{sv})  item,
                         IN  a{sv}     options);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.RemoveConfigurationItem" title="The RemoveConfigurationItem() method">RemoveConfigurationItem</a> (IN  (sa{sv})  item,
                         IN  a{sv}     options);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.UpdateConfigurationItem" title="The UpdateConfigurationItem() method">UpdateConfigurationItem</a> (IN  (sa{sv})  old_item,
                         IN  (sa{sv})  new_item,
                         IN  a{sv}     options);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.GetSecretConfiguration" title="The GetSecretConfiguration() method">GetSecretConfiguration</a>  (IN  a{sv}     options,
                         OUT a(sa{sv}) configuration);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.Format" title="The Format() method">Format</a>                  (IN  s         type,
                         IN  a{sv}     options);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.OpenForBackup" title="The OpenForBackup() method">OpenForBackup</a>           (IN  a{sv}     options,
                         OUT h         fd);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.OpenForRestore" title="The OpenForRestore() method">OpenForRestore</a>          (IN  a{sv}     options,
                         OUT h         fd);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.OpenForBenchmark" title="The OpenForBenchmark() method">OpenForBenchmark</a>        (IN  a{sv}     options,
                         OUT h         fd);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.OpenDevice" title="The OpenDevice() method">OpenDevice</a>              (IN  s         mode,
                         IN  a{sv}     options,
                         OUT h         fd);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.Rescan" title="The Rescan() method">Rescan</a>                  (IN  a{sv}     options);
</pre>
</div>
<div class="refsect1">
<a name="id-1.3.3.6.4"></a><h2>Properties</h2>
<pre class="synopsis">
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.Device" title='The "Device" property'>Device</a>                 readable   ay
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.PreferredDevice" title='The "PreferredDevice" property'>PreferredDevice</a>        readable   ay
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.Symlinks" title='The "Symlinks" property'>Symlinks</a>               readable   aay
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.DeviceNumber" title='The "DeviceNumber" property'>DeviceNumber</a>           readable   t
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.Id" title='The "Id" property'>Id</a>                     readable   s
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.Size" title='The "Size" property'>Size</a>                   readable   t
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.ReadOnly" title='The "ReadOnly" property'>ReadOnly</a>               readable   b
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.Drive" title='The "Drive" property'>Drive</a>                  readable   o
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.MDRaid" title='The "MDRaid" property'>MDRaid</a>                 readable   o
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.MDRaidMember" title='The "MDRaidMember" property'>MDRaidMember</a>           readable   o
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.IdUsage" title='The "IdUsage" property'>IdUsage</a>                readable   s
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.IdType" title='The "IdType" property'>IdType</a>                 readable   s
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.IdVersion" title='The "IdVersion" property'>IdVersion</a>              readable   s
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.IdLabel" title='The "IdLabel" property'>IdLabel</a>                readable   s
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.IdUUID" title='The "IdUUID" property'>IdUUID</a>                 readable   s
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.Configuration" title='The "Configuration" property'>Configuration</a>          readable   a(sa{sv})
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.CryptoBackingDevice" title='The "CryptoBackingDevice" property'>CryptoBackingDevice</a>    readable   o
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.HintPartitionable" title='The "HintPartitionable" property'>HintPartitionable</a>      readable   b
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.HintSystem" title='The "HintSystem" property'>HintSystem</a>             readable   b
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.HintIgnore" title='The "HintIgnore" property'>HintIgnore</a>             readable   b
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.HintAuto" title='The "HintAuto" property'>HintAuto</a>               readable   b
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.HintName" title='The "HintName" property'>HintName</a>               readable   s
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.HintIconName" title='The "HintIconName" property'>HintIconName</a>           readable   s
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.HintSymbolicIconName" title='The "HintSymbolicIconName" property'>HintSymbolicIconName</a>   readable   s
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.UserspaceMountOptions" title='The "UserspaceMountOptions" property'>UserspaceMountOptions</a>  readable   as
</pre>
</div>
<div class="refsect1">
<a name="gdbus-interface-org-freedesktop-UDisks2-Block"></a><h2>Description</h2>
<p>    This interface represents a block device.
</p>
<p>    This should not be confused with the
    <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-interface-org-freedesktop-UDisks2-Drive.top_of_page">org.freedesktop.UDisks2.Drive</a> interface that is used to represent
    disk drives. For example, the <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-interface-org-freedesktop-UDisks2-Block.top_of_page">org.freedesktop.UDisks2.Block</a>
    interface is also used for block devices that do not correspond to
    drives at all (e.g. <a class="ulink" href="http://en.wikipedia.org/wiki/Loop_device" target="_top">Loop
    Devices</a>).
</p>
</div>
<div class="refsect1">
<a name="gdbus-methods-org.freedesktop.UDisks2.Block"></a><h2>Method Details</h2>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Block.AddConfigurationItem"></a><h3>The AddConfigurationItem() method</h3>
<pre class="programlisting">
AddConfigurationItem (IN  (sa{sv}) item,
                      IN  a{sv}    options);
</pre>
<p>        Adds a new configuration item.
</p>
<p>        See the <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.Configuration" title='The "Configuration" property'>"Configuration"</a>
        property for details about valid configuration items.
</p>
<p>        Some fields can be omitted and will then receive default
        values.  This is useful when passing configuration items to
        Format, for example, because the proper values are not known
        before the formatting is done.
</p>
<p>        If 'fsname' is omitted in a 'fstab' entry, or 'device' is
        omitted in a 'crypttab' entry, it defaults to "UUID=..." when
        the block device has a filesystem UUID, or to the name of the
        device in the filesystem..
</p>
<p>        If 'name' is omitted in a 'crypttab' entry, it defaults to
        "luks-&lt;UUID&gt;".
</p>
<p>        If 'passphrase-path' is omitted, it defaults to
        "/etc/luks-keys/&lt;NAME&gt;".
</p>
<p>        If 'track-parents' is set to true in <em class="parameter"><code>item</code></em>, then the 'opts'
        and 'options' fields will be augmented with "x-parent"
        elements, as appropriate.  This will make <em class="parameter"><code>item</code></em> appear in the
        ChildConfiguration properties, and will allow the 'tear-down'
        option of Format, DeletePartition, and other methods to remove
        this item reliably.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN (sa{sv}) <em class="parameter"><code>item</code></em></code>:</span></p></td>
<td><p>The configuration item to add.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).</p></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Block.RemoveConfigurationItem"></a><h3>The RemoveConfigurationItem() method</h3>
<pre class="programlisting">
RemoveConfigurationItem (IN  (sa{sv}) item,
                         IN  a{sv}    options);
</pre>
<p>        Removes an existing configuration item.
</p>
<p>        See the <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.Configuration" title='The "Configuration" property'>"Configuration"</a>
        property for details about valid configuration items.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN (sa{sv}) <em class="parameter"><code>item</code></em></code>:</span></p></td>
<td><p>The configuration item to remove.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).</p></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Block.UpdateConfigurationItem"></a><h3>The UpdateConfigurationItem() method</h3>
<pre class="programlisting">
UpdateConfigurationItem (IN  (sa{sv}) old_item,
                         IN  (sa{sv}) new_item,
                         IN  a{sv}    options);
</pre>
<p>        Removes a configuration item and adds a new one. This is
        equivalent to calling
        <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.RemoveConfigurationItem" title="The RemoveConfigurationItem() method">RemoveConfigurationItem()</a>
        followed by
        <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.AddConfigurationItem" title="The AddConfigurationItem() method">AddConfigurationItem()</a>
        with the change that only one PolicyKit check is made
        and that <em class="parameter"><code>new_item</code></em> can be validated against <em class="parameter"><code>old_item</code></em>.
</p>
<p>        See the <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.Configuration" title='The "Configuration" property'>"Configuration"</a>
        property for details about valid configuration items.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN (sa{sv}) <em class="parameter"><code>old_item</code></em></code>:</span></p></td>
<td><p>The configuration item to remove.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN (sa{sv}) <em class="parameter"><code>new_item</code></em></code>:</span></p></td>
<td><p>The configuration item to add. Must be of the same type as <em class="parameter"><code>old_item</code></em>.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).</p></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Block.GetSecretConfiguration"></a><h3>The GetSecretConfiguration() method</h3>
<pre class="programlisting">
GetSecretConfiguration (IN  a{sv}     options,
                        OUT a(sa{sv}) configuration);
</pre>
<p>        Returns the same value as in the
        <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.Configuration" title='The "Configuration" property'>"Configuration"</a> property
        but without secret information filtered out.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT a(sa{sv}) <em class="parameter"><code>configuration</code></em></code>:</span></p></td>
<td><p>The resulting configuration.</p></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Block.Format"></a><h3>The Format() method</h3>
<pre class="programlisting">
Format (IN  s     type,
        IN  a{sv} options);
</pre>
<p>        Formats the device with a file system, partition table or
        other well-known content.
</p>
<p>        Known values for <em class="parameter"><code>type</code></em> includes <code class="constant">empty</code> (to
        just zero out areas of the device known to host file system
        signatures) and <code class="constant">swap</code> (Linux swap space)
        and most file systems supported by the <span class="citerefentry"><span class="refentrytitle">mkfs</span>(8)</span>
        program through its <code class="option">-t</code> option.
</p>
<p>        Known partition table formats includes
        <code class="constant">dos</code> and <code class="constant">gpt</code>.
</p>
<p>        If <em class="parameter"><code>type</code></em> supports it, you can specify a label with the
        <em class="parameter"><code>label</code></em> option in the <em class="parameter"><code>options</code></em> parameter;
        however, note that this may not be supported on all file
        systems and, if supported, the maximum allowed length may
        vary.
</p>
<p>        If the file system in question supports owners and the option
        <em class="parameter"><code>take-ownership</code></em> is set to <code class="constant">TRUE</code> then the
        root directory of the created file system will be owned by the
        caller of this method.
</p>
<p>        If the option <em class="parameter"><code>encrypt.passphrase</code></em> is
        given then a LUKS device is created with the given passphrase
        and the file system is created on the unlocked device. The
        unlocked device will be left open. This parameter can be used
        to supply the binary contents of an arbitrary keyfile by passing
        a value of type <span class="quote">“<span class="quote">ay</span>”</span>.
        Option <em class="parameter"><code>encrypt.type</code></em> can be used to
        specify encryption "technology" that will be used. Currently
        only <span class="quote">“<span class="quote">luks1</span>”</span> and <span class="quote">“<span class="quote">luks2</span>”</span> are supported.
</p>
<p>        If the option <em class="parameter"><code>erase</code></em> is used then the
        underlying device will be erased. Valid values include
        <span class="quote">“<span class="quote">zero</span>”</span> to write zeroes over the entire device
        before formatting, <span class="quote">“<span class="quote">ata-secure-erase</span>”</span> to perform
        a secure erase or <span class="quote">“<span class="quote">ata-secure-erase-enhanced</span>”</span> to
        perform an enhanced secure erase.
</p>
<p>        If the option <em class="parameter"><code>update-partition-type</code></em> is
        set to <code class="constant">TRUE</code> and the object in question is a partition, then
        its type (cf. the <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-property-org-freedesktop-UDisks2-Partition.Type" title='The "Type" property'>"Type"</a>
        property) will be set to the <span class="emphasis"><em>natural</em></span>
        partition type matching <em class="parameter"><code>type</code></em>, if any. For example, if
        formatting a GPT partition with a FAT filesystem, the
        <span class="quote">“<span class="quote">Microsoft Basic Data</span>”</span> partition type will be
        chosen; similar, if formatting a DOS partition with a Ext4
        filesystem then partition type 0x83 is chosen.
</p>
<p>        If the option <em class="parameter"><code>no-block</code></em> is set to <code class="constant">TRUE</code>
        then the method returns just before the actual formatting
        takes place but after authorization and other checks are
        done. This is useful for applications that want to format
        several devices in parallel.
</p>
<p>        If the option <em class="parameter"><code>dry-run-first</code></em> is set to
        <code class="constant">TRUE</code> then a dry run of the formatting command is performed
        first, if Udisks knows how to do that.  The idea is that
        this allows a deeper check of the parameters even when
        <em class="parameter"><code>no-block</code></em> is <code class="constant">TRUE</code>.
</p>
<p>        If the option <em class="parameter"><code>no-discard</code></em> is set to
        <code class="constant">TRUE</code> then Udisks tells the formatting utility not to issue
        BLKDISCARD ioctls.
</p>
<p>        If the option <em class="parameter"><code>config-items</code></em> is set, it
        should be an array of configuration items suitable for
        org.freedesktop.UDisks2.Block.AddConfigurationItem.  They will
        all be added after the formatting is done.
</p>
<p>        If the option <em class="parameter"><code>tear-down</code></em> is set to
        <code class="constant">TRUE</code>, then the block device and all its children will be
        cleaned up before formatting.  This cleanup consists of
        removing entries from /etc/fstab and /etc/crypttab, and
        locking of encrypted block devices.  Entries in /etc/fstab and
        /etc/crypttab that have been created with the 'track-parents'
        options to AddConfigurationItem will be removed even if their
        block device is currently unavailable.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>type</code></em></code>:</span></p></td>
<td><p>The type of file system, partition table or other content to format the device with.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>Options - known options (in addition to <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>) includes <em class="parameter"><code>label</code></em> (of type 's'), <em class="parameter"><code>take-ownership</code></em> (of type 'b'), <em class="parameter"><code>encrypt.passphrase</code></em> (of type 's' or 'ay'), <em class="parameter"><code>encrypt.type</code></em> (of type 's'), <em class="parameter"><code>erase</code></em> (of type 's'), <em class="parameter"><code>no-block</code></em> (of type 'b') and <em class="parameter"><code>update-partition-type</code></em> (of type 'b').</p></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Block.OpenForBackup"></a><h3>The OpenForBackup() method</h3>
<pre class="programlisting">
OpenForBackup (IN  a{sv} options,
               OUT h     fd);
</pre>
<p>        Gets a read-only file descriptor for the device intended for a
        byte-by-byte imaging of the device. This can only be done if
        the device is not already in use.
</p>
<p>        <span class="emphasis"><em>This method is deprecated since 2.7.3.</em></span>
        Use <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.OpenDevice" title="The OpenDevice() method">OpenDevice()</a> with <code class="literal">O_EXCL</code>
        and <code class="literal">O_CLOEXEC</code> flags instead.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT h <em class="parameter"><code>fd</code></em></code>:</span></p></td>
<td><p>An index for the returned file descriptor.</p></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Block.OpenForRestore"></a><h3>The OpenForRestore() method</h3>
<pre class="programlisting">
OpenForRestore (IN  a{sv} options,
                OUT h     fd);
</pre>
<p>        Gets a writable file descriptor for the device intended for a
        byte-by-byte restore of a disk image onto the device. This can
        only be done if the device is not already in use.
</p>
<p>        <span class="emphasis"><em>This method is deprecated since 2.7.3.</em></span>
        Use <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.OpenDevice" title="The OpenDevice() method">OpenDevice()</a> with <code class="literal">O_EXCL</code>,
        <code class="literal">O_SYNC</code> and <code class="literal">O_CLOEXEC</code> flags instead.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT h <em class="parameter"><code>fd</code></em></code>:</span></p></td>
<td><p>An index for the returned file descriptor.</p></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Block.OpenForBenchmark"></a><h3>The OpenForBenchmark() method</h3>
<pre class="programlisting">
OpenForBenchmark (IN  a{sv} options,
                  OUT h     fd);
</pre>
<p>        Gets a file descriptor for the device that is suitable to be
        used for benchmarking the device (transfer rate, access time
        etc.). Note that the file descriptor may be opened with the
        <code class="literal">O_DIRECT</code> and <code class="literal">O_SYNC</code>
        flags so care must be taken to only perform block-aligned I/O.
</p>
<p>        If the <em class="parameter"><code>writable</code></em> in <em class="parameter"><code>options</code></em> is <code class="constant">TRUE</code>
        then the returned file descriptor will be writable. This only
        works if the device is not already in use.
</p>
<p>        <span class="emphasis"><em>This method is deprecated since 2.7.3.</em></span>
        Use <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.OpenDevice" title="The OpenDevice() method">OpenDevice()</a> with <code class="literal">O_DIRECT</code>,
        <code class="literal">O_SYNC</code> and <code class="literal">O_CLOEXEC</code> flags instead.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT h <em class="parameter"><code>fd</code></em></code>:</span></p></td>
<td><p>An index for the returned file descriptor.</p></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Block.OpenDevice"></a><h3>The OpenDevice() method</h3>
<pre class="programlisting">
OpenDevice (IN  s     mode,
            IN  a{sv} options,
            OUT h     fd);
</pre>
<p>        Option <em class="parameter"><code>flags</code></em> can be used to specify additional flags.
        See <code class="literal">man 2 open</code> for list of supported flags.
        <code class="literal">O_RDONLY</code>, <code class="literal">O_WRONLY</code> and
        <code class="literal">O_RDWR</code> are not allowed, use <em class="parameter"><code>mode</code></em> instead.
</p>
<p>        Gets a file descriptor for the device.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>mode</code></em></code>:</span></p></td>
<td><p>Mode: "r" for read-only, "w" for write-only or "rw" for read-write</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>Options - known options (in addition to <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>) includes <em class="parameter"><code>flags</code></em> (of type 'i')</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT h <em class="parameter"><code>fd</code></em></code>:</span></p></td>
<td><p>An index for the returned file descriptor.</p></td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.7.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Block.Rescan"></a><h3>The Rescan() method</h3>
<pre class="programlisting">
Rescan (IN  a{sv} options);
</pre>
<p>        Request that the kernel and core OS rescans the contents of
        the device and update their state to reflect this (including
        things such as the <code class="filename">/dev/disk/</code> hierarchy
        of symlinks). This includes requesting that the kernel
        re-reads the partition table, if appropriate.
</p>
<p>        This is usually not needed since the OS automatically does
        this when the last process with a writable file descriptor for
        the device closes it.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).</p></td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="gdbus-properties-org.freedesktop.UDisks2.Block"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Block.Device"></a><h3>The "Device" property</h3>
<pre class="programlisting">
Device  readable   ay
</pre>
<p>The special device file for the block device e.g. <code class="filename">/dev/sda2</code>.</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Block.PreferredDevice"></a><h3>The "PreferredDevice" property</h3>
<pre class="programlisting">
PreferredDevice  readable   ay
</pre>
<p>         The special device file to present in the UI instead of the value
         of the <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.Device" title='The "Device" property'>"Device"</a> property.
</p>
<p>         For example this could be
         e.g. <code class="filename">/dev/mapper/mpathk</code> for a multipath
         device with special device file <code class="filename">/dev/dm-9</code>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Block.Symlinks"></a><h3>The "Symlinks" property</h3>
<pre class="programlisting">
Symlinks  readable   aay
</pre>
<p>         Known symlinks in <code class="filename">/dev</code> that points to
         the device file in the
         <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.Device" title='The "Device" property'>"Device"</a> property.
</p>
<p>         For example, this array could include symlinks such as
         <code class="filename">/dev/disk/by-id/ata-INTEL_SSDSA2MH080G1GC_CVEM842101HD080DGN</code>
         and
         <code class="filename">/dev/disk/by-id/wwn-0x5001517387d61905</code>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Block.DeviceNumber"></a><h3>The "DeviceNumber" property</h3>
<pre class="programlisting">
DeviceNumber  readable   t
</pre>
<p>The dev_t of the block device.</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Block.Id"></a><h3>The "Id" property</h3>
<pre class="programlisting">
Id  readable   s
</pre>
<p>         A unique and persistent identifier for the device or blank if
         no such identifier is available.
</p>
<p>         For devices with fixed media, this identifier is derived from
         vital product data / UUIDs / serial numbers of the drive or
         construct (e.g. LVM or MD-RAID) the block device is part
         of. For devices with removable media, this identifier is
         derived from the medium currently inserted.
</p>
<p>         This identifier is guaranteed to not include the slash
         character '/' (U+002F SOLIDUS) which means it can be used as
         a filename.
</p>
<p>         Examples:
         <span class="quote">“<span class="quote">by-id-ata-INTEL_SSDSA2MH080G1GC_CVEM842101HD080DGN</span>”</span>,
         <span class="quote">“<span class="quote">by-id-ata-ST1000LM024_HN-M101MBB_S2TBJA0C230233-part3</span>”</span>,
         <span class="quote">“<span class="quote">by-id-usb-Kingston_DataTraveler_2.0_0013729940C4F9A166250D3E-0:0</span>”</span>,
         <span class="quote">“<span class="quote">by-id-dm-name-luks-6d81fe85-26b1-4f8b-b834-405454c1cd46</span>”</span>,
         <span class="quote">“<span class="quote">by-id-dm-name-vg_thinkpad-lv_swap</span>”</span>,
         <span class="quote">“<span class="quote">by-label-HARRY_POTTER_SORCERERS_STONE-</span>”</span>,
         <span class="quote">“<span class="quote">by-uuid-D22D-08B8</span>”</span>.
</p>
<p class="since">Since 2.0.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Block.Size"></a><h3>The "Size" property</h3>
<pre class="programlisting">
Size  readable   t
</pre>
<p>The size of the block device.</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Block.ReadOnly"></a><h3>The "ReadOnly" property</h3>
<pre class="programlisting">
ReadOnly  readable   b
</pre>
<p>If <code class="constant">TRUE</code>, the device can not be written to, only read from.</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Block.Drive"></a><h3>The "Drive" property</h3>
<pre class="programlisting">
Drive  readable   o
</pre>
<p>         The <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-interface-org-freedesktop-UDisks2-Drive.top_of_page">org.freedesktop.UDisks2.Drive</a> object that the block device
         belongs to, or '/' if no such object exists.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Block.MDRaid"></a><h3>The "MDRaid" property</h3>
<pre class="programlisting">
MDRaid  readable   o
</pre>
<p>         If the block device is a running MD-RAID array, this is set
         to the <a class="link" href="gdbus-org.freedesktop.UDisks2.MDRaid.html#gdbus-interface-org-freedesktop-UDisks2-MDRaid.top_of_page">org.freedesktop.UDisks2.MDRaid</a> object that it
         correspond to. Is '/' if no such object exists.
</p>
<p class="since">Since 2.0.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Block.MDRaidMember"></a><h3>The "MDRaidMember" property</h3>
<pre class="programlisting">
MDRaidMember  readable   o
</pre>
<p>         If the block device is a member of a MD-RAID array, this
         is set to the <a class="link" href="gdbus-org.freedesktop.UDisks2.MDRaid.html#gdbus-interface-org-freedesktop-UDisks2-MDRaid.top_of_page">org.freedesktop.UDisks2.MDRaid</a> object that it
         correspond to. Is '/' if no such object exists.
</p>
<p class="since">Since 2.0.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Block.IdUsage"></a><h3>The "IdUsage" property</h3>
<pre class="programlisting">
IdUsage  readable   s
</pre>
<p>         A result of probing for signatures on the block device. Known values include:
         </p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">filesystem</span></p></td>
<td><p>Used for mountable filesystems</p></td>
</tr>
<tr>
<td><p><span class="term">crypto</span></p></td>
<td><p>Used for e.g. LUKS devices</p></td>
</tr>
<tr>
<td><p><span class="term">raid</span></p></td>
<td><p>Used for e.g. RAID members and LVM PVs</p></td>
</tr>
<tr>
<td><p><span class="term">other</span></p></td>
<td><p>Something else was detected.</p></td>
</tr>
</tbody>
</table></div>
<p>
         If blank, no known signature was detected. This doesn't
         necessarily mean the device contains no structured data; it
         only means that no signature known to the probing code was
         detected.
</p>
<p>         Applications should not rely on the value in this or the
         <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.IdType" title='The "IdType" property'>"IdType"</a> property - instead,
         applications should check for whether the object in question
         implements interfaces such as
         e.g. <a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.html#gdbus-interface-org-freedesktop-UDisks2-Filesystem.top_of_page">org.freedesktop.UDisks2.Filesystem</a>,
         <a class="link" href="gdbus-org.freedesktop.UDisks2.Swapspace.html#gdbus-interface-org-freedesktop-UDisks2-Swapspace.top_of_page">org.freedesktop.UDisks2.Swapspace</a> or
         <a class="link" href="gdbus-org.freedesktop.UDisks2.Encrypted.html#gdbus-interface-org-freedesktop-UDisks2-Encrypted.top_of_page">org.freedesktop.UDisks2.Encrypted</a>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Block.IdType"></a><h3>The "IdType" property</h3>
<pre class="programlisting">
IdType  readable   s
</pre>
<p>        This property contains more information about the result of
        probing the block device. Its value depends of the value the
        <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.IdUsage" title='The "IdUsage" property'>"IdUsage"</a> property:
        </p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">filesystem</span></p></td>
<td><p>The mountable file system that was detected (e.g. <code class="literal">vfat</code>).</p></td>
</tr>
<tr>
<td><p><span class="term">crypto</span></p></td>
<td><p>Encrypted data. Known values include <code class="literal">crypto_LUKS</code>.</p></td>
</tr>
<tr>
<td><p><span class="term">raid</span></p></td>
<td><p><a class="ulink" href="http://en.wikipedia.org/wiki/RAID" target="_top">RAID</a> or similar. Known values include <code class="literal">LVM2_member</code> (for LVM2 components), <code class="literal">linux_raid_member</code> (for MD-RAID components.)</p></td>
</tr>
<tr>
<td><p><span class="term">other</span></p></td>
<td><p>Something else. Known values include <code class="literal">swap</code> (for swap space), <code class="literal">suspend</code> (data used when resuming from suspend-to-disk.</p></td>
</tr>
</tbody>
</table></div>
<p>
        See the note for the <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.IdUsage" title='The "IdUsage" property'>"IdUsage"</a> property about usage.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Block.IdVersion"></a><h3>The "IdVersion" property</h3>
<pre class="programlisting">
IdVersion  readable   s
</pre>
<p>         The version of the filesystem or other structured data on the block device.
         Do not make any assumptions about the format.
</p>
<p>         This property is blank if there is no version or the version is unknown.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Block.IdLabel"></a><h3>The "IdLabel" property</h3>
<pre class="programlisting">
IdLabel  readable   s
</pre>
<p>         The label of the filesystem or other structured data on the block device.
</p>
<p>         This property is blank if there is no label or the label is unknown.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Block.IdUUID"></a><h3>The "IdUUID" property</h3>
<pre class="programlisting">
IdUUID  readable   s
</pre>
<p>         The <a class="ulink" href="http://en.wikipedia.org/wiki/UUID" target="_top">UUID</a> of the
         filesystem or other structured data on the block device. Do not make
         any assumptions about the UUID as its format depends on what kind of
         data is on the device.
</p>
<p>         This property is blank if there is no UUID or the UUID is unknown.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Block.Configuration"></a><h3>The "Configuration" property</h3>
<pre class="programlisting">
Configuration  readable   a(sa{sv})
</pre>
<p>         The configuration for the device.
</p>
<p>         This is an array of pairs of (<em class="parameter"><code>type</code></em>, <em class="parameter"><code>details</code></em>) where <em class="parameter"><code>type</code></em> is
         a string identifying the configuration source
         (e.g. <code class="literal">fstab</code>) and <em class="parameter"><code>details</code></em> contains the
         actual configuration data.
</p>
<p>         Use the
         <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.AddConfigurationItem" title="The AddConfigurationItem() method">AddConfigurationItem()</a>,
         <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.RemoveConfigurationItem" title="The RemoveConfigurationItem() method">RemoveConfigurationItem()</a>
         and
         <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.UpdateConfigurationItem" title="The UpdateConfigurationItem() method">UpdateConfigurationItem()</a>
         methods to add, remove and update configuration items.
</p>
<p>         Use
         <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.GetSecretConfiguration" title="The GetSecretConfiguration() method">GetSecretConfiguration()</a>
         to get the secrets (e.g. passphrases) that may be part of the
         configuration but isn't exported in this property for
         security reasons.
</p>
<p>         For entries of type <code class="literal">fstab</code>, it means that
         the block device is referenced in the system-wide
         <code class="filename">/etc/fstab</code> file. Known configuration
         items for type <code class="literal">fstab</code> are
         </p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">fsname (type <code class="literal">'ay'</code>)</span></p></td>
<td><p>The special device</p></td>
</tr>
<tr>
<td><p><span class="term">dir (type <code class="literal">'ay'</code>)</span></p></td>
<td><p>The mount point</p></td>
</tr>
<tr>
<td><p><span class="term">type (type <code class="literal">'ay'</code>)</span></p></td>
<td><p>The filesystem type</p></td>
</tr>
<tr>
<td><p><span class="term">opts (type <code class="literal">'ay'</code>)</span></p></td>
<td><p>Options</p></td>
</tr>
<tr>
<td><p><span class="term">freq (type <code class="literal">'i'</code>)</span></p></td>
<td><p>Dump frequency in days</p></td>
</tr>
<tr>
<td><p><span class="term">passno (type <code class="literal">'i'</code>)</span></p></td>
<td><p>Pass number of parallel fsck</p></td>
</tr>
</tbody>
</table></div>
<p>
</p>
<p>         For entries of type <code class="literal">crypttab</code>, it means that
         the block device is referenced in the system-wide
         <code class="filename">/etc/crypttab</code> file. Known configuration
         items for type <code class="literal">crypttab</code> are
         </p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">name (type <code class="literal">'ay'</code>)</span></p></td>
<td><p>The name to set the device up as</p></td>
</tr>
<tr>
<td><p><span class="term">device (type <code class="literal">'ay'</code>)</span></p></td>
<td><p>The special device</p></td>
</tr>
<tr>
<td><p><span class="term">passphrase-path (type <code class="literal">'ay'</code>)</span></p></td>
<td><p>Either empty to specify that no password is set,
           otherwise a path to a file containing the encryption password.
           This may also point to a special device file in <code class="filename">/dev</code>
           such as <code class="literal">/dev/random</code>.
           </p></td>
</tr>
<tr>
<td><p><span class="term">passphrase-contents (type <code class="literal">'ay'</code>)</span></p></td>
<td><p>The contents of the file containing the encryption password, if applicable.
           This is only available via the <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.GetSecretConfiguration" title="The GetSecretConfiguration() method">GetSecretConfiguration()</a>
           method.</p></td>
</tr>
<tr>
<td><p><span class="term">opts (type <code class="literal">'ay'</code>)</span></p></td>
<td><p>Options</p></td>
</tr>
</tbody>
</table></div>
<p>
         For security reasons, when creating a new
         <code class="literal">crypttab</code> entry (via the
         <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.AddConfigurationItem" title="The AddConfigurationItem() method">AddConfigurationItem()</a>
         method), then the <code class="option">passphrase-path</code> must
         reference an unexisting file in the
         <code class="filename">/etc/luks-keys</code> directory.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Block.CryptoBackingDevice"></a><h3>The "CryptoBackingDevice" property</h3>
<pre class="programlisting">
CryptoBackingDevice  readable   o
</pre>
<p>         The <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-interface-org-freedesktop-UDisks2-Block.top_of_page">org.freedesktop.UDisks2.Block</a> object that is
         backing the device or <code class="literal">/</code> if unknown or if
         the block device is not the cleartext device for an encrypted
         device.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Block.HintPartitionable"></a><h3>The "HintPartitionable" property</h3>
<pre class="programlisting">
HintPartitionable  readable   b
</pre>
<p>         If <code class="constant">TRUE</code>, the device is normally expected to be
         partitionable. Devices for which this is not the case include
         floppy drives, optical drives and LVM logical volumes.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Block.HintSystem"></a><h3>The "HintSystem" property</h3>
<pre class="programlisting">
HintSystem  readable   b
</pre>
<p>If <code class="constant">TRUE</code>, the device is considered a <span class="emphasis"><em>system device</em></span>.</p>
<p>         System devices are devices that require additional permissions to access.
</p>
<p>         See <a class="xref" href="udisks.8.html" title="udisks"><span class="refentrytitle">udisks</span>(8)</a> for how to influence the value of this property.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Block.HintIgnore"></a><h3>The "HintIgnore" property</h3>
<pre class="programlisting">
HintIgnore  readable   b
</pre>
<p>If <code class="constant">TRUE</code>, the device should be hidden from users.</p>
<p>         See <a class="xref" href="udisks.8.html" title="udisks"><span class="refentrytitle">udisks</span>(8)</a> for how to influence the value of this property.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Block.HintAuto"></a><h3>The "HintAuto" property</h3>
<pre class="programlisting">
HintAuto  readable   b
</pre>
<p>If <code class="constant">TRUE</code>, the device should be automatically started (e.g. mounted, unlocked etc.).</p>
<p>         See <a class="xref" href="udisks.8.html" title="udisks"><span class="refentrytitle">udisks</span>(8)</a> for how to influence the value of this property.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Block.HintName"></a><h3>The "HintName" property</h3>
<pre class="programlisting">
HintName  readable   s
</pre>
<p>If not blank, the name to use when presenting the device.</p>
<p>         See <a class="xref" href="udisks.8.html" title="udisks"><span class="refentrytitle">udisks</span>(8)</a> for how to influence the value of this property.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Block.HintIconName"></a><h3>The "HintIconName" property</h3>
<pre class="programlisting">
HintIconName  readable   s
</pre>
<p>If not blank, the icon name to use when presenting the device.</p>
<p>         The name must adhere to the
         <a class="ulink" href="http://www.freedesktop.org/wiki/Specifications/icon-theme-spec" target="_top">freedesktop.org icon theme specification</a>.
</p>
<p>         See <a class="xref" href="udisks.8.html" title="udisks"><span class="refentrytitle">udisks</span>(8)</a> for how to influence the value of this property.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Block.HintSymbolicIconName"></a><h3>The "HintSymbolicIconName" property</h3>
<pre class="programlisting">
HintSymbolicIconName  readable   s
</pre>
<p>         If not blank, the icon name to use when presenting the device using a symbolic icon.
</p>
<p>         The name must adhere to the
         <a class="ulink" href="http://www.freedesktop.org/wiki/Specifications/icon-theme-spec" target="_top">freedesktop.org icon theme specification</a>.
</p>
<p>         See <a class="xref" href="udisks.8.html" title="udisks"><span class="refentrytitle">udisks</span>(8)</a> for how to influence the value of this property.
</p>
<p class="since">Since 2.0.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Block.UserspaceMountOptions"></a><h3>The "UserspaceMountOptions" property</h3>
<pre class="programlisting">
UserspaceMountOptions  readable   as
</pre>
<p>List of userspace mount options.</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.29</div>
</body>
</html>